Layout

Inside Macintosh: OpenDoc Class Reference / Part 2 - Types and Constants

Layout
This section describes the types and constants used when parts lay themselves out for display.

Icons
The following type represents a family of icons, including 16 by 16, 32 by 32, and so forth.

ODIconFamily
An opaque platform-specific type that contains a collection of icons for rendering a part or other content in icon form. On the Mac OS, this type is the same as an IconSuite handle.

The following 16-bit constants specify the size of icons, expressed as the number of pixels in either dimension of the icon.

kODLargeIconSize
The size of a large icon, which is 32 by 32 pixels.
kODSmallIconSize
The size of a small icon, which is 16 by 16 pixels.
kODThumbnailSize
The size of a thumbnail icon, which is 64 by 64 pixels.
kODTinyIconSize
The size of a tiny icon, which is 12 by 12 pixels.

Facets
The following types and constants describe nongeometric information about facets.

ODHighlight
An enumeration specifying the possible highlight states of a facet.
Constants of this type

kODDimHighlight
Highlighted in background style.
kODFullHighlight
Highlighted in foreground style.
kODNoHighlight
Not highlighted.
ODSiblingOrder
An enumeration specifying the order in which siblings are processed when iterating through a facet hierarchy.
Constants of this type

kODBackToFront
From back to front.
kODFrontToBack
From front to back.
ODTraversalType
An enumeration specifying the order of iteration through a facet hierarchy. The root of the hierarchy is the facet whose embedded facets are being traversed. If that facet's sibling order is front to back, sibling facets at the same level in the hierarchy are traversed starting with the frontmost; if the sibling order is back to front, sibling facets are traversed starting with the backmost.
Constants of this type

kODBottomUp
Traverse the facet hierarchy bottom up, visiting a parent facet after visiting all its children. If sibling order is front to back, traversal starts with the frontmost facet at the lowest level in the hierarchy; if back to front, at the backmost facet at the lowest level.
kODChildrenOnly
Traverse only the children of the root facet.
kODTopDown
Traverse the facet hierarchy top down, in depth-first order.

Frames
The following types and constants describe nongeometric information about frames.

ODFramePosition
An enumeration specifying the possible positions of a frame relative to a sibling frame

Constants of this type

kODFrameBehind
This frame is behind its sibling.
kODFrameInFront
This frame is in front of its sibling.
ODLinkStatus
An enumeration specifying the link status of a frame.

ODLinkStatus
An enumeration specifying the link status of a frame

Constants of this type

kODInLinkDestination
The frame is embedded in the destination of a link; the content of this frame is thus supplied by a link.
kODInLinkSource
The frame is embedded in content that is the source of one or more links, but not in content that is the destination of a link.
kODNotInLink
The frame is not embedded in any linked content, source or destination.

The following constants of type ODType (page 876) specify frame view types and presentations. OpenDoc methods use the tokenized strings for view types and presentations. You can call the session object's Tokenize method (page 622) to obtain a token corresponding to one of these constants.
Presentations

kODPresDefault
The default presentation for a frame.
View types

kODViewAsFrame
Frame.
kODViewAsLargeIcon
Large icon (standard icon).
kODViewAsSmallIcon
Small icon.
kODViewAsThumbnail
Thumbnail icon.

Part Info
The following type represents part-specific data stored with a frame or a facet.

ODInfoType
An opaque type for the part info data. To use the data, you should cast an ODInfoType value to and from a pointer to your part's own representation of the data.